/*
 * Tigase XMPP Server - The instant messaging server
 * Copyright (C) 2004 Tigase, Inc. (office@tigase.com)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, version 3 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. Look for COPYING file in the top folder.
 * If not, see http://www.gnu.org/licenses/.
 */
package tigase.xmpp;

import tigase.server.Packet;

import java.util.Map;
import java.util.Queue;

/**
 * Describe interface XMPPStopListener here.
 * <br>
 * Created: Sat Oct 14 16:14:18 2006
 *
 * @author <a href="mailto:artur.hefczyc@tigase.org">Artur Hefczyc</a>
*/
public interface XMPPStopListenerIfc
		extends XMPPImplIfc {

	/**
	 * Performs additional processing upon closing user session (user either disconnects or logs-out).
	 *
	 * @param session user session which keeps all the user session data and also gives an access to the user's
	 * repository data. It allows for storing information in a permanent storage or in memory only during the live of
	 * the online session. This parameter can be null if there is no online user session at the time of the packet
	 * processing.
	 * @param results this a collection with packets which have been generated as input packet processing results.
	 * Regardless a response to a user request is sent or the packet is forwarded to it's destination it is always
	 * required that a copy of the input packet is created and stored in the results queue.
	 * @param settings this map keeps plugin specific settings loaded from the Tigase server configuration. In most
	 * cases it is unused, however if the plugin needs to access an external database that this is a way to pass
	 * database connection string to the plugin.
	 */
	void stopped(XMPPResourceConnection session, Queue<Packet> results, Map<String, Object> settings);
}    // XMPPStopListener
